home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / ARCHIVE / ARCX100.ZIP;1 / ARCX.DOC < prev    next >
Encoding:
Text File  |  1994-05-14  |  18.5 KB  |  865 lines
  1.  
  2.  
  3.                                                                            
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                              A r c h i v e r X
  13.                                       
  14.                                  Version 1
  15.                                       
  16.                                       
  17.                                       
  18.                          Users manual Version 1.00
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.                            (c)1994  Tsuneo Tanaka
  26.                             All rights reserved.
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.                                 11 May 1994
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.                                                                            
  47.  
  48.  
  49.  
  50.  
  51. ArchiverX Version 1                                            Users manual
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                            1.  LICENSE AGREEMENT
  61.  
  62.  
  63. THIS PRODUCT IS PROVIDED AS IS WITHOUT ANY WARRANTY  OR  GUARANTEE  OF  ANY
  64. KIND,   EITHER  EXPRESSED OR IMPLIED. IN NO EVENT WILL THE AUTHOR BE LIABLE
  65. FOR ANY DAMAGES,  INCLUDING, BUT NOT LIMITED TO, ANY LOST PROFITS, SAVINGS,
  66. DATA OR OTHER INCIDENTAL,  CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE  OF
  67. THIS PRODUCT.
  68.  
  69. You  may  copy  and  distribute  ArchiverX  distribution  archives   freely
  70. regardless of commercial or noncommercial, provided you do not modify it at
  71. all.  MODIFYING,   DISASSEMBLING,   DECOMPILING  OR  EXTRACTING   ARCHIVERX
  72. EXCUTABLE IS PROHIBITED.
  73.  
  74.  
  75.  
  76.  
  77.  
  78.  
  79.                               2.  REGISTRATION
  80.  
  81.  
  82.      ArchiverX  is  not  freeware  or  public domain. ArchiverX is released
  83. under the shareware concept. You are  free  to  use  this  product  for  an
  84. evaluation  period  of 30 days. After this period,  you have to register or
  85. discontinue use of this product.
  86.  
  87.      Registering ArchiverX will include free upgrades to the product for up
  88. to but not including next major version.
  89.  
  90.      To register,  please fill the order form out and  send  it  with  your
  91. registration  fee,   shipping and handling charge to the following address.
  92.  
  93.  
  94.                                      1                                     
  95.  
  96.  
  97.  
  98.  
  99. ArchiverX Version 1                                            Users manual
  100.  
  101.  
  102. You will be sent your registration key to make an  unregistered  evaluation
  103. copy  of ArchiverX registered copy. Please set it in the configuration file
  104. and write it down somewhere other than your memory not to loose it.
  105.  
  106.         Tsuneo Tanaka
  107.         75-3, Hatagaya 3-chome
  108.         Shibuya-ku, TOKYO
  109.         151 JAPAN
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.                               3.  INSTALLATION
  117.  
  118.  
  119.  
  120.      First of all, you need to make a directory and unpack the distribution
  121. archive into it.  If you have not done yet, please do it.<g>
  122.  
  123.      In most cases,  nothing is necessary to run ArchiverX, but if you like
  124. using other archivers rather than archivers already  defined  in  ARCX.CFG,
  125. edit ARCX.CFG as you like.
  126.  
  127.      If  there is another ARCX.EXE (or you do not like the file name),  you
  128. can rename all ARCX.* to <Something>.*. Please note that the names  of  the
  129. configuration  files  must  be  matched with the name of executable. Or you
  130. will get many errors.
  131.  
  132.      To run ArchiverX on your computer,  the following things are required.
  133. As you see,  no special equipment is required,  so I think it must  run  on
  134. most  of  DOS-based  computers,   including  NEC  PC-9800  series  personal
  135. computers.
  136.  
  137.         80x86-based computer [*1]
  138.         Microsoft DOS or IBM DOS
  139.         Expanded memory (optional)
  140.  
  141.  
  142.                                      2                                     
  143.  
  144.  
  145.  
  146.  
  147. ArchiverX Version 1                                            Users manual
  148.  
  149.  
  150.         Extended memory (optional)
  151.         Hard drive (optional)
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185. -- note -----------------
  186.  
  187.  [*1] ArchiverX may not work on 80x88-based computers.
  188.  
  189.  
  190.                                      3                                     
  191.  
  192.  
  193.  
  194.  
  195. ArchiverX Version 1                                            Users manual
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.                            4.  CONFIGURATION FILE
  205.  
  206.  
  207. 4.1  System section
  208.  
  209.  
  210. 4.1.1  RegistrationName <Name>
  211.  
  212.      Name for registration.
  213.  
  214.  
  215. 4.1.2  RegistrationKey <Key>
  216.  
  217.      Key code sent from the author.
  218.  
  219.  
  220. 4.1.3  SwapToDir <Directory>[[;<Directory]...]
  221.  
  222.      Directory(ies) for  swapping  conventional  memory.  If  not  defined,
  223. current directory will be used.
  224.  
  225.  
  226. 4.1.4  SwapToEms
  227.  
  228.      If not enabled, EMS will not be used.
  229.  
  230.  
  231. 4.1.5  SwapToXms
  232.  
  233.      If not enabled, XMS will not be used.
  234.  
  235.  
  236.  
  237.  
  238.                                      4                                     
  239.  
  240.  
  241.  
  242.  
  243. ArchiverX Version 1                                            Users manual
  244.  
  245.  
  246.  
  247.  
  248. 4.1.6  SwapToInt15
  249.  
  250.      If  not  enabled,   extended  memory  which can be used through int 15
  251. interface will not be used.
  252.  
  253.  
  254. 4.1.7  SaveDirectories <Directories>
  255.  
  256.      Directories  to  be  saved  at  executing  external  utilities.  (e.g.
  257. SaveDirectories CDEFGHIJKLMNOPQRSTUVWXYZ)
  258.  
  259.  
  260. 4.1.8  AlternateTesterCommand <CommandLine> (Optional)
  261.  
  262.      Command line to test archives alternately.  (e.g. SCAN.EXE *.*)
  263.  
  264.  
  265. 4.1.9  AlternateTesterTemporaryDirectory <Directory> (Optional)
  266.  
  267.      Directory to store extracted files temporally. <Directory> MUST NOT BE
  268. USED BY OTHER PROGRAMS.  (e.g. D:\DELETE)
  269.  
  270.  
  271. 4.1.10  LogFile <FileName>
  272.  
  273.      Where to record information about its operations. (e.g. \LOG\ARCX.LOG)
  274.  
  275.  
  276. 4.1.11  LogLevel <n>
  277.  
  278.      How verbose to make the log file.  From 0 to 5.  (e.g. LogLevel 5)
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.                                      5                                     
  287.  
  288.  
  289.  
  290.  
  291. ArchiverX Version 1                                            Users manual
  292.  
  293.  
  294.  
  295.  
  296. 4.2  Archiver <Description>
  297.  
  298.      Each archiver program is defined in this section.
  299.  
  300.      In  this  section,  the following letters will be replaced as occasion
  301. calls.
  302.  
  303.  
  304. 4.2.1  %a
  305.  
  306.      Replaced with an archive name given by user.
  307.  
  308.         PKZIP -v %a
  309.    ==>  PKZIP -v DOCS.ZIP
  310.  
  311.  
  312. 4.2.2  %f
  313.  
  314.      Replaced with file names. In "Extract" commands, this will be replaced
  315. with both file names and a directory.
  316.  
  317.         PKZIP -v %a %f
  318.    ==>  PKZIP -v DOCS.ZIP MEET*.* ORDER*.*
  319.  
  320.         PKZIP -x %a %f
  321.    ==>  PKZIP -x DOCS.ZIP MEET*.* ORDER*.* TEMP\
  322.  
  323.  
  324. 4.2.3  %l
  325.  
  326.      Replaced with a list file name.
  327.  
  328.         PKZIP -v %a %f %l
  329.    ==>  PKZIP -v DOCS.ZIP MEET*.* ORDER*.* @FILE.LST [*2]
  330.  
  331.  
  332.  
  333.  
  334.                                      6                                     
  335.  
  336.  
  337.  
  338.  
  339. ArchiverX Version 1                                            Users manual
  340.  
  341.  
  342.  
  343.  
  344. 4.2.4  Extension <Extension>
  345.  
  346.      Archive's extension. (e.g. ZIP, LZH, ARC, PAK, EXE)
  347.  
  348.  
  349. 4.2.5  Ident <Offset>,<HexadecimalString>
  350.  
  351.      String of hexadecimal to identify archives. (e.g. 0,504b0304)
  352.  
  353.      If <Offset> is less than zero, it indicates a offset from the end of a
  354. archive. (e.g. -2,fe)
  355.  
  356.  
  357. 4.2.6  ListPrefix <Prefix>
  358.  
  359.      Prefix to pass listing file to command line. (e.g. "@")
  360.  
  361.  
  362. 4.2.7  Add <CommandLine>
  363.  
  364.  
  365. 4.2.8  Add_WithPaths <CommandLine>
  366.  
  367.  
  368. 4.2.9  Add_RecurseDirs <CommandLine>
  369.  
  370.  
  371. 4.2.10  Move <CommandLine>
  372.  
  373.  
  374.  
  375.  
  376.  
  377. -- note -----------------
  378.  
  379.  [*2] Prefixes other than "@" can be defined.  See ListPrefix.
  380.  
  381.  
  382.                                      7                                     
  383.  
  384.  
  385.  
  386.  
  387. ArchiverX Version 1                                            Users manual
  388.  
  389.  
  390.  
  391.  
  392. 4.2.11  Move_WithPaths <CommandLine>
  393.  
  394.  
  395. 4.2.12  Move_RecurseDirs <CommandLine>
  396.  
  397.  
  398. 4.2.13  Extract <CommandLine>
  399.  
  400.  
  401. 4.2.14  Extract_WithPaths <CommandLine>
  402.  
  403.  
  404. 4.2.15  View <CommandLine>
  405.  
  406.  
  407. 4.2.16  Delete <CommandLine>
  408.  
  409.  
  410. 4.2.17  AddComment <CommandLine>
  411.  
  412.  
  413. 4.2.18  Freshen <CommandLine>
  414.  
  415.  
  416. 4.2.19  Update <CommandLine>
  417.  
  418.  
  419. 4.2.20  Update_WithPaths <CommandLine>
  420.  
  421.  
  422. 4.2.21  Update_RecurseDirs <CommandLine>
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.                                      8                                     
  431.  
  432.  
  433.  
  434.  
  435. ArchiverX Version 1                                            Users manual
  436.  
  437.  
  438.  
  439.  
  440. 4.2.22  Test <CommandLine>
  441.  
  442.      Command lines to run archivers. If archivers do not support  commands,
  443. comment each line out.
  444.  
  445.  
  446.  
  447.  
  448.  
  449.  
  450.                              5.  LANGUAGE FILE
  451.  
  452.  
  453.      All messages except system messages can be modified. The format of the
  454. language files is very simple.
  455.  
  456. <identifier> "<string>" (e.g. cmd_add "-a")
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.                         6.  COMMAND LINE PARAMETERS
  464.  
  465.  
  466.         C:\>ARCX[.EXE] <Command> [[<Command>]...]
  467.                        <ArchiveFileMask>
  468.                        [[<FileMask>]...]
  469.                        [<Directory>\]
  470.                        [@<ListFile>]
  471.  
  472.  
  473.  
  474.  
  475.  
  476.  
  477.  
  478.                                      9                                     
  479.  
  480.  
  481.  
  482.  
  483. ArchiverX Version 1                                            Users manual
  484.  
  485.  
  486.  
  487.  
  488. 6.1  Fixed commands
  489.  
  490.  
  491. 6.1.1  --c
  492.  
  493.         --c <ConfigFile>         Use <ConfigFile> instead of ARCX.CFG
  494.  
  495.  
  496. 6.1.2  --L
  497.  
  498.         --L                      Show software license
  499.  
  500.  
  501. 6.2  User-defined commands
  502.  
  503.      All commands mentioned below can be changed in ARCX.LNG
  504.  
  505.  
  506. 6.2.1  -a
  507.  
  508.         -a <ArchiveFile> [[<FileMask>]...] [@<ListFile>]
  509.                                  Add file(s) into <ArchiveFile>
  510.  
  511.  
  512. 6.2.2  -m
  513.  
  514.         -m <ArchiveFile> [[<FileMask>]...] [@<ListFile>]
  515.                                  Move file(s) to <ArchiveFile>
  516.  
  517.  
  518. 6.2.3  -x
  519.  
  520.         -x <ArchiveFile> [[<FileMask>]...] [<Directory>\\] [@<ListFile>]
  521.                                  Extract <ArchiveFile> into <Directory>
  522.                                  If <Directory> is not given, current
  523.                                  directory will be used.
  524.  
  525.  
  526.                                     10                                     
  527.  
  528.  
  529.  
  530.  
  531. ArchiverX Version 1                                            Users manual
  532.  
  533.  
  534.  
  535.  
  536. 6.2.4  -v
  537.  
  538.         -v <ArchiveFile> [[<FileMask>]...] [@<ListFile>]
  539.                                  View <ArchiveFile>
  540.  
  541.  
  542. 6.2.5  -d
  543.  
  544.         -d <ArchiveFile> [[<FileMask>]...] [@<ListFile>]
  545.                                  Delete file(s) from <ArchiveFile>
  546.  
  547.  
  548. 6.2.6  -z
  549.  
  550.         -z <ArchiveFile> <TextFile> [@<ListFile>]
  551.                                  Add <TextFile> into <ArchiveFile> as
  552.                                  comment.
  553.                                  For example:
  554.                                    ARCX -z *.* COMMENT.TXT
  555.                                      Add a zip comment (COMMENT.TXT)
  556.                                      to all files in the current
  557.                                      directory regardless of archive-
  558.                                      type.
  559.  
  560.  
  561. 6.2.7  -f
  562.  
  563.         -f <ArchiveFile> [[<FileMask>]...] [@<ListFile>]
  564.                                  Freshen <ArchiveFile>.
  565.                                  Replace file(s) into <ArchiveFile> if
  566.                                  file(s) are newer.
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.                                     11                                     
  575.  
  576.  
  577.  
  578.  
  579. ArchiverX Version 1                                            Users manual
  580.  
  581.  
  582.  
  583.  
  584. 6.2.8  -u
  585.  
  586.         -u <ArchiveFile> [[<FileMask>]...] [@<ListFile>]
  587.                                  Update <ArchiveFile>.
  588.                                  Replace file(s) into <ArchiveFile> if
  589.                                  file(s) are newer.  If not exists,
  590.                                  file(s) will be added.
  591.  
  592.  
  593. 6.2.9  -t
  594.  
  595.         -t <ArchiveFile>
  596.                                  Test <ArchiveFile>.
  597.                                  For example:
  598.                                    ARCX -t *.*
  599.                                      Test all files in the current
  600.                                      directory using both archivers
  601.                                      and alternate scanners.
  602.                                      If LogFile option is enabled,
  603.                                      each errorlevel will be recorded
  604.                                      to the log file.
  605.  
  606.  
  607.  
  608.  
  609.  
  610.  
  611.                              7.  HOW TO CONTACT
  612.  
  613.  
  614.      If you have any problem,  suggestion or complaint, please feel free to
  615. contact the author. Any comments,  especially written in easy English, will
  616. be gratefully appreciated.
  617.  
  618.         Tsuneo Tanaka
  619.  
  620.  
  621.  
  622.                                     12                                     
  623.  
  624.  
  625.  
  626.  
  627. ArchiverX Version 1                                            Users manual
  628.  
  629.  
  630.         BBS    : Tokyo Online +81-3-3378-0069
  631.         NetMail: FidoNet 6:730/23
  632.                  OS2NET  81:710/1
  633.  
  634. P.S.  I'm  now  looking for registration sites for FidoNet Zone 1 and 2. If
  635. you are interested, please contact me via netmail.
  636.  
  637.  
  638.  
  639.  
  640.  
  641.  
  642.  
  643.  
  644.  
  645.  
  646.  
  647.  
  648.  
  649.  
  650.  
  651.  
  652.  
  653.  
  654.  
  655.  
  656.  
  657.  
  658.  
  659.  
  660.  
  661.  
  662.  
  663.  
  664.  
  665.  
  666.  
  667.  
  668.  
  669.  
  670.                                     13                                     
  671.  
  672.  
  673.  
  674.  
  675. ArchiverX Version 1                                            Users manual
  676.  
  677.  
  678.                             - Acknowledgements -
  679.  
  680.  
  681.      Special thanks to Ralf Brown for providing the SPAWNO  routines.  This
  682. product  uses  it  to minimize memory use while shelling to DOS and running
  683. other programs.
  684.  
  685.  
  686.  
  687. Microsoft is a trademark of Microsoft.
  688. PKZIP, PKWARE is trademarks of PKWARE, Inc.
  689. ARC is a trademark of System Enhancements Associates, Inc.
  690. PAK is a trademark of NoGate Consulting.
  691. FidoNet is a trademark of Tom Jennings.
  692. IBM is a trademark of IBM Corporation.
  693. SCAN, McAFEE are trademarks of McAfee Associates.
  694.  
  695.  
  696.  
  697.  
  698.  
  699.  
  700.  
  701.  
  702.  
  703.  
  704.  
  705.  
  706.  
  707.  
  708.  
  709.  
  710.  
  711.  
  712.  
  713.  
  714.  
  715.  
  716.  
  717.  
  718.                                     14                                     
  719.  
  720.  
  721.  
  722.  
  723. ArchiverX Version 1                                            Users manual
  724.  
  725.  
  726.                                  - Index -
  727.  
  728.  
  729. --L License 10
  730. --c Configuration 10
  731. -a Add 10
  732. -d Delete 11
  733. -f Freshen 11
  734. -m Move 10
  735. -t Test 12
  736. -u Update 12
  737. -v View 11
  738. -x Extract 10
  739. -z Comment 11
  740. add 7 10 11
  741. comment 8 11
  742. delete 8 11
  743. extension 7
  744. extract 8 10
  745. freshen 8 11
  746. ident 7
  747. language 9
  748. listprefix 7
  749. move 7 8 10
  750. replace 11 12
  751. test 9
  752. update 8 12
  753. view 8 11
  754.  
  755.  
  756.  
  757.  
  758.  
  759.  
  760.  
  761.  
  762.  
  763.  
  764.  
  765.  
  766.                                     15                                     
  767.  
  768.  
  769.  
  770.  
  771. ArchiverX Version 1                                            Users manual
  772.  
  773.  
  774.                                 - Contents -
  775.  
  776.  
  777. 1.  LICENSE AGREEMENT ................................................    1
  778. 2.  REGISTRATION .....................................................    1
  779. 3.  INSTALLATION .....................................................    2
  780. 4.  CONFIGURATION FILE ...............................................    4
  781.    4.1  System section ...............................................    4
  782.       4.1.1  RegistrationName <Name> .................................    4
  783.       4.1.2  RegistrationKey <Key> ...................................    4
  784.       4.1.3  SwapToDir <Directory>[[;<Directory]...] .................    4
  785.       4.1.4  SwapToEms ...............................................    4
  786.       4.1.5  SwapToXms ...............................................    4
  787.       4.1.6  SwapToInt15 .............................................    5
  788.       4.1.7  SaveDirectories <Directories> ...........................    5
  789.       4.1.8  AlternateTesterCommand <CommandLine> (Optional) .........    5
  790.       4.1.9  AlternateTesterTemporaryDirectory <Directory> (Optional)     5
  791.       4.1.10  LogFile <FileName> .....................................    5
  792.       4.1.11  LogLevel <n> ...........................................    5
  793.    4.2  Archiver <Description> .......................................    6
  794.       4.2.1  %a ......................................................    6
  795.       4.2.2  %f ......................................................    6
  796.       4.2.3  %l ......................................................    6
  797.       4.2.4  Extension <Extension> ...................................    7
  798.       4.2.5  Ident <Offset>,<HexadecimalString> ......................    7
  799.       4.2.6  ListPrefix <Prefix> .....................................    7
  800.       4.2.7  Add <CommandLine> .......................................    7
  801.       4.2.8  Add_WithPaths <CommandLine> .............................    7
  802.       4.2.9  Add_RecurseDirs <CommandLine> ...........................    7
  803.       4.2.10  Move <CommandLine> .....................................    7
  804.       4.2.11  Move_WithPaths <CommandLine> ...........................    8
  805.       4.2.12  Move_RecurseDirs <CommandLine> .........................    8
  806.       4.2.13  Extract <CommandLine> ..................................    8
  807.       4.2.14  Extract_WithPaths <CommandLine> ........................    8
  808.       4.2.15  View <CommandLine> .....................................    8
  809.       4.2.16  Delete <CommandLine> ...................................    8
  810.       4.2.17  AddComment <CommandLine> ...............................    8
  811.       4.2.18  Freshen <CommandLine> ..................................    8
  812.  
  813.  
  814.                                     16                                     
  815.  
  816.  
  817.  
  818.  
  819. ArchiverX Version 1                                            Users manual
  820.  
  821.  
  822.       4.2.19  Update <CommandLine> ...................................    8
  823.       4.2.20  Update_WithPaths <CommandLine> .........................    8
  824.       4.2.21  Update_RecurseDirs <CommandLine> .......................    8
  825.       4.2.22  Test <CommandLine> .....................................    9
  826. 5.  LANGUAGE FILE ....................................................    9
  827. 6.  COMMAND LINE PARAMETERS ..........................................    9
  828.    6.1  Fixed commands ...............................................   10
  829.       6.1.1  --c .....................................................   10
  830.       6.1.2  --L .....................................................   10
  831.    6.2  User-defined commands ........................................   10
  832.       6.2.1  -a ......................................................   10
  833.       6.2.2  -m ......................................................   10
  834.       6.2.3  -x ......................................................   10
  835.       6.2.4  -v ......................................................   11
  836.       6.2.5  -d ......................................................   11
  837.       6.2.6  -z ......................................................   11
  838.       6.2.7  -f ......................................................   11
  839.       6.2.8  -u ......................................................   12
  840.       6.2.9  -t ......................................................   12
  841. 7.  HOW TO CONTACT ...................................................   12
  842.  
  843.  
  844.  
  845.  
  846.  
  847.  
  848.  
  849.  
  850.  
  851.  
  852.  
  853.  
  854.  
  855.  
  856.  
  857.  
  858.  
  859.  
  860.  
  861.  
  862.                                     17                                     
  863.  
  864.  
  865.